Import/Export in the uP5 Manual(#1241) #2859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ChristianMurphy
added
Hacktoberfest
documentation
|
@ChristianMurphy ready to merge ? |
|
@555vedant enhance your calm, give people a chance to review. 🙂 |
|
@ChristianMurphy thnx for suggestions |
|
With uPortal 5, the data import/export tasks are invoked using Gradle. The commands and its parameters are same for the most part, so the documentation needs to be updated to reflect that |
|
in this format template is more readable !! |
jonathanmtran
requested changes
Oct 1, 2024
There was a problem hiding this comment.
Running ./gradlew :overlays:uPortal:tasks outputs the following
Data tasks
----------
dataDelete - Deletes the specified entity. Requires -Dtype={entity-type} and -Dsysid={id}
dataExport - Creates XML files representing the requested entities and writes them to the specified file system location. Parameters: -Ddir={path-to-directory} -Dtype={entity-type} [-Dsysid={entity-identifier}]
dataImport - Adds to or updates the portal database for the entities defined in the specified XML file(s). Requires -Dfile={path-to-file} or -Ddir={path-to-directory}
dataInit - Drop and recreate uPortal tables and reimport data
dataList - With no arguments (-Dtype={entity-type}) lists all supported portal data types and the operations (export, delete) supported for each.
src: https://github.com/uPortal-Project/uPortal-start/blob/master/overlays/uPortal/build.gradle
|
@jonathanmtran Changes done. |
|
@jonathanmtran PR ready to merge ?? |
|
Please squash the commits into one |
|
@jonathanmtran squashing done |
jonathanmtran
approved these changes
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the Import/Export tool documentation for uPortal to reflect the new commands in uP5. It replaces outdated commands with the current syntax and usage, ensuring accuracy and clarity. The documentation includes step-by-step instructions and examples to guide users through the Import/Export process. Additionally, it addresses any discrepancies found in the previous version.